<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimeStreamNull: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="Streams.html" title="Streams">
<link rel="prev" href="GMimeStreamMmap.html" title="GMimeStreamMmap">
<link rel="next" href="GMimeStreamFilter.html" title="GMimeStreamFilter">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GMimeStreamNull.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GMimeStreamNull.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Streams.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GMimeStreamMmap.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GMimeStreamFilter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GMimeStreamNull"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GMimeStreamNull.top_of_page"></a>GMimeStreamNull</span></h2>
<p>GMimeStreamNull — A null stream</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GMimeStreamNull.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeStreamNull.html#g-mime-stream-null-new" title="g_mime_stream_null_new ()">g_mime_stream_null_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GMimeStreamNull.html#g-mime-stream-null-get-count-newlines" title="g_mime_stream_null_get_count_newlines ()">g_mime_stream_null_get_count_newlines</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeStreamNull.html#g-mime-stream-null-set-count-newlines" title="g_mime_stream_null_set_count_newlines ()">g_mime_stream_null_set_count_newlines</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeStreamNull.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GMimeStreamNull.html#GMimeStreamNull-struct" title="struct GMimeStreamNull">GMimeStreamNull</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeStreamNull.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
        <span class="lineart">╰──</span> GMimeStreamNull
</pre>
</div>
<div class="refsect1">
<a name="GMimeStreamNull.description"></a><h2>Description</h2>
<p>A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which has no real backing storage at all. This
stream is useful for dry-runs and can also be useful for
determining statistics on source data which can be written to
streams but cannot be read as a stream itself (e.g. a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
via <a class="link" href="GMimeObject.html#g-mime-object-write-to-stream" title="g_mime_object_write_to_stream ()"><code class="function">g_mime_object_write_to_stream()</code></a>).</p>
</div>
<div class="refsect1">
<a name="GMimeStreamNull.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-stream-null-new"></a><h3>g_mime_stream_null_new ()</h3>
<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
g_mime_stream_null_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GMimeStreamNull.html" title="GMimeStreamNull"><span class="type">GMimeStreamNull</span></a> object.</p>
<div class="refsect3">
<a name="g-mime-stream-null-new.returns"></a><h4>Returns</h4>
<p> a new null stream (similar to /dev/null on Unix).</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-null-get-count-newlines"></a><h3>g_mime_stream_null_get_count_newlines ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_stream_null_get_count_newlines (<em class="parameter"><code><a class="link" href="GMimeStreamNull.html" title="GMimeStreamNull"><span class="type">GMimeStreamNull</span></a> *stream</code></em>);</pre>
<p>Gets whether or not the stream should keep track of the number of newlines
encountered.</p>
<div class="refsect3">
<a name="g-mime-stream-null-get-count-newlines.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stream</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStreamNull.html" title="GMimeStreamNull"><span class="type">GMimeStreamNull</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-stream-null-get-count-newlines.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the stream should count the number of newlines or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-null-set-count-newlines"></a><h3>g_mime_stream_null_set_count_newlines ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_stream_null_set_count_newlines (<em class="parameter"><code><a class="link" href="GMimeStreamNull.html" title="GMimeStreamNull"><span class="type">GMimeStreamNull</span></a> *stream</code></em>,
                                       <em class="parameter"><code><span class="type">gboolean</span> count</code></em>);</pre>
<p>Sets whether or not the stream should keep track of the number of newlines
encountered.</p>
<div class="refsect3">
<a name="g-mime-stream-null-set-count-newlines.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stream</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStreamNull.html" title="GMimeStreamNull"><span class="type">GMimeStreamNull</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>count</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if newlines should be counted or <code class="literal">FALSE</code> otherwise</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeStreamNull.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimeStreamNull-struct"></a><h3>struct GMimeStreamNull</h3>
<pre class="programlisting">struct GMimeStreamNull;</pre>
<p>A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which has no backing store.</p>
<div class="refsect3">
<a name="GMimeStreamNull.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeStreamNull.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>